メインコンテンツまでスキップ

無害化ファイルダウンロード

無害化処理が完了したファイルをダウンロードします。
成功時ファイルバイナリストリームを返し、失敗時JSON形式のエラーメッセージを返します。

備考

Important Notes

  • Prerequisite: 必ず状態照会API(GET /v5/cdr/{jobID}の応答codeが**0(成功)または1(例外/原本返入)**時だけ呼び出す必要があります。
  • Blocked Files: 政策によってブロックされたファイル(code: 2)はダウンロードできません。
  • Expiration: サーバーのファイル保管期間が過ぎたファイルは自動的に削除され、ダウンロードできません(code: -2). 再リクエストが必要です。

1. API 概要

1.1 API リスト

処理が完了したファイル(無害化されたか、ポリシーの例外で原本が持ち込まれた場合)を提供します。

MethodAPI説明
GET/v5/download/{jobID}CDRファイルのダウンロードをリクエストします。

Base URL

http://{IP または ドメイン}:{PORT}
項目内容
基本ポート8060(環境に応じて80ポートで構成される場合があります)
エンコーディングUTF-8
警告

重要

  • GET /v5/cdr状態照会(または同期無害化応答)後code値が**0(成功)または1(例外)**の場合のみ/v5/downloadを呼び出します。

  • ブロックされたファイルについては、ダウンロードを提供しません。


2. ファイルダウンロード

2.1 API 情報

GET /v5/download/{jobID}

Request Path Parameter

FieldTypeRequiredDescription
jobIDStringY無害化リクエスト作業に関するID。リクエスト時に生成された値またはリクエスト応答で返された値を使用します。最大36文字。

2.2 成功応答 (ファイルダウンロード)

処理が完了したファイルを提供します。 (無害化処理されたか、ポリシー例外で原本が持ち込まれた場合)

項目
HTTP Status200 OK
Content-Typeapplication/octet-stream
Bodyバイナリデータ (ファイル本体)
EncodingUTF-8

code: 1(ポリシー例外)の場合、無害化されていない元のファイルが返されます。

2.3 失敗応答 (JSON)

ダウンロードが不可能な場合にのみ発生するコードです。政策によってブロックされたり、保管期間が満了してファイルが削除された場合などが該当します。

項目
HTTP Status200 OK
Content-Typeapplication/json
FieldTypeDescription
jobIDString無害化リクエスト作業に関するID
codeIntegerダウンロードリクエストに対する結果
msgStringcodeに関する Description メッセージ

code

codeDescription
5無効なリクエストを拒否
3無害化が進行中の場合
2ポリシーによるファイルブロックのためダウンロード不可
-1不明なエラーが発生しました(ダウンロード不可の状態)
-2ファイルをダウンロードできない場合(サーバーにファイル保管期間を過ぎたため削除されました。新たに無害化リクエストが必要です)

2.4 Sample

REQUEST

curl -X GET "http://{IP}:8060/v5/download/test-job-001" -O -J

RESPONSE — 成功

  • ファイルバイナリが返されます。 (Content-Type: application/octet-stream)

RESPONSE — ブロックされたファイル (code 2)

{
"jobID": "test-job-001",
"code": 2,
"msg": "정책에 의한 파일 차단으로 다운로드 불가"
}

RESPONSE — 進行中 (code 3)

{
"jobID": "test-job-001",
"code": 3,
"msg": "무해화가 진행중인 경우"
}

RESPONSE — ファイルがありません (code -2)

{
"jobID": "test-job-001",
"code": -2,
"msg": "다운로드 할 파일이 없는 경우"
}